Add Symbol Dialog

This dialog is used to insert ProjectWise and/or system variables when defining naming patterns/conventions for folder and file names, and opens when you click the Add Symbol button on the following dialogs:

Source File Presentation Settings dialog
Output File Naming Convention dialog
Output Destination Folder dialog

When the Add Symbol dialog opens, select a category of properties on the left, then select a specific property variable on the right, then click OK.

Note: Not all of the property variables belonging to the selected category are exposed.

The following categories are available:

Document
Folder
Work Area
Environment
Print Definition
General

Note: When a date or time variable is selected, a Format list displays below the list of variables for you to select which date or time format to use when the variable is replaced with a real value. For example, <Date?format=ddMMMMyyyy> or <Time?format=HHmm>

Document Category

The following document property variables are provided:

Variable Name	Variable	Description
Base Description	`<Document.BaseDescription>`	Inserts the document's description (without the extension, if there is one).
Base File Name	`<Document.BaseFileName>`	Inserts the file name (without the file name extension, if there is one).
Base Name	`<Document.BaseName>`	Inserts the name of the original document (without the file extension, if there is one).
Created Time	`<Document.CreatedTime>`	Inserts the document creation date/time.
Creator	`<Document.Creator>`	Inserts the document created by value.
Department	`<Document.Department>`	Inserts the document's department.
Description	`<Document.Description>`	Inserts the document's description.
Description Extension	`<Document.DescriptionExtension>`	Inserts the extension component of the document description. Includes the leading period, if present. Available in the destination file name symbol, but not rendition file names.
File Name	`<Document.FileName>`	Inserts the file name.
File Name Extension	`<Document.FileNameExtension>`	Inserts the extension component of the document file name. Includes the leading period, if present. Available in the destination file name symbol, but not rendition file names.
File Updated Time	`<Document.FileUpdatedTime>`	Inserts the document file updated date/time.
File Updater	`<Document.FileUpdater>`	Inserts the document file updated by value
ID	`<Document.ID>`	Inserts the document's ID number within the folder. For example, if the selected document is the second file placed in a folder, this field displays the numeral "2".
Modified Time	`<Document.ModifiedTime>`	Inserts the most recent of the document created time, updated time, and file updated time.
Name	`<Document.Name>`	Inserts the name of the original document.
Name Extension	`<Document.NameExtension>`	Inserts the extension component of the document name. Includes the leading period, if present. Available in the destination file name symbol, but not rendition file names.
Sequence	`<Document.Sequence>`	Inserts the document's version sequence number. For example, if the selected document is the original version of the document, this field displays the numeral "0".
State	`<Document.State>`	Inserts the document's state.
State Description	`<Document.StateDescription>`	Inserts the document's state description.
Updated Time	`<Document.UpdatedTime>`	Inserts the document updated date/time.
Updater	`<Document.Updater>`	Inserts the document updated by value.
Version	`<Document.Version>`	Inserts the document's version.
Workflow	`<Document.Workflow>`	Inserts the document's workflow.
Workflow Description	`<Document.WorkflowDescription>`	Inserts the document's workflow description.

Folder Category

The following folder property variables are provided:

Variable Name	Variable	Description
Description	`<Folder.Description>`	Inserts the folder's description.
Environment	`<Folder.Environment>`	Inserts the folder's environment.
ID	`<Folder.ID>`	Inserts the folder's ID number within its parent folder.
Name	`<Folder.Name>`	Inserts the folder's name.
URL	`<Folder.Url>`	Inserts the datasource folder path of the input files folder. This variable is only available when defining the settings file path on the Source File Presentation Settings dialog.
Work Area URL	`<Folder.ProjectUrl>`	Inserts the URL of the nearest work area containing the given document. May be empty.

Work Area Category

When the Work Area category is selected, a Name list displays for you to select from the available work area types in the datasource. When you select a work area type, the work area properties available in the selected work area type are displayed in the variables list.

Environment Category

When the Environment category is selected, a Name list displays for you to select from the available environments in the datasource. When you select an environment, the attributes available in the selected environment are displayed in the variables list.

Print Definition Category

This category is only available when the Add Symbol dialog is opened from the Output File Naming Convention dialog.

The following print definition property variables are provided:

Variable Name	Description
Count	Inserts the print definition count number, which is the total number of print definitions in the print set. For example, if you have `<PrintDef.Name> - <PrintDef.SetNumber> of <PrintDef.Count>` for the file name pattern and you create individual PDFs from an IPS file, you could produce rendition files such as ElecA - 1 of 3.pdf, ElecB - 2 of 3.pdf, and ElecC - 3 of 3.pdf.
Model Name	Inserts the document's model name. For example, if you have `<PrintDef.Name> - <PrintDef.ModelName>` for the file name pattern and an IPS file with the print definitions ElecA, ElecB, and ElecC, with model names ANSI A, ANSI B, and ANSI C, respectively; you could produce rendition files such as ElecA - ANSI A.pdf, ElecB - ANSI B.pdf, and ElecC - ANSI C.pdf.
Name	Inserts the base name of the master file when creating individual rendition files from master files. Inserts the plot name for the current plot set index (which may have been customized by the user inside the IPS file) when creating individual rendition files from an IPS file. Returns the InterPlot Plot Set (IPS) name minus the extension when creating a composite PDF from an IPS file. For example, if you create a file name pattern containing just `<PrintDef.Name>`, and you create a composite PDF for Learn.ips, you will get Learn.pdf.
Set Name	Inserts the base file name of the master file when creating individual rendition files from master files. Returns the IPS file name minus the extension when creating a composite PDF from an IPS file or when creating individual rendition files from an IPS file.
Set Number	Inserts the row number of the print definition in an IPS file. For example, if you have `<Document.BaseName> - <PrintDef.SetNumber?format=D2>` for the file name pattern and you create individual rendition files from a single DGN file (in the case of multiple models and shapes), you could produce rendition files such as shapes - 01.pdf, shapes - 02.pdf, and shapes - 02.pdf.
Sheet Name	Inserts the sheet name. The Sheet Name is defined on the Create Model or Model Properties dialogs when creating or modifying sheet models.
Sheet Number	Inserts the sheet number. The Sheet Number is defined on the Create Model or Model Properties dialogs when creating or modifying sheet models.

General Category

The following general property variables are provided:

Variable Name	Variable	Description
Date	`<Date>`	Inserts the current date.
Time	`<Time>`	Inserts the current time.
User Description	`<UserDescription>`	Inserts the user description of the ProjectWise user account.
User Name	`<UserName>`	Inserts the user name of the ProjectWise user account.